Data - Get reservation details

GET 
/v1/reservations/:id

Get the reservation details for a given reservation id.

Request

Path Parameters

id stringrequired

restaurant uuid that needs to be considered for filter

Responses

200

Successful

*/*

Schema

Schema

reservationUuid stringrequired

reservation uuid

restaurantUuid stringrequired

restaurant uuid

mealDate daterequired

Reservation meal date

partySize integerrequired

Number of person attending to the reservation

status stringrequired
Possible values: [RECORDED, CONFIRMED, CANCELED, NO_SHOW, REQUESTED, REFUSED]
• Reservation status
• Main statuses
  • - RECORDED: most frequent status, reservation is confirmed
  • - CANCELED: reservation has been canceled
  • - NO_SHOW: reservation has been flagged as no-show
• Secondary statuses
  • - REQUESTED: Reservation is waiting for a an action from the restaurant (on request booking or Waitlist) - not confirmed yet
  • - REFUSED: final state if a requested reservation has been declined by the restaurant
  • - REJECTED: general error on the reservation (should be rare)
offerUuid string
customerNote string

Possible values: <= 1000 characters

Special request field that the diner can enter while making the reservation

customerUuid string

Customer UUID

customFields

object[]

Array [

labelUuid stringrequired

Label UUID

label stringrequired

Label value

type stringrequired

Possible values: [boolean, string, integer]

value stringrequired

valueUuid string

Value UUID

]

offerDetails

object

offerType stringrequired

Possible values: [promotion, presetMenu]

name object

discountPercentage number

presetMenuType string

Possible values: [generic, of_the_day, brunch, group, experience]

price number

currency string

utmTrackingInformation

object[]

Array [

key stringrequired

value stringrequired

]

billAmount

object

totalPrice numberrequired

currency stringrequired
reservationChannel stringrequired

Possible values: [TripAdvisor, Michelin, Booking Module, Offline, TheFork, Walk-in, Google, Cross Sell]

createdAt stringrequired
updatedAt string

Example (from schema)

{
  "reservationUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "restaurantUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "mealDate": "2022-01-03T18:10:17.269Z",
  "partySize": 2,
  "status": "RECORDED",
  "offerUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "customerNote": "note by the customer",
  "customerUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "customFields": [
    {
      "labelUuid": "55749b38-b822-4ece-b976-65a1458c6d47",
      "label": "Regular lunch customer",
      "type": "boolean",
      "value": "string",
      "valueUuid": "ada0f099-4e3d-47da-addd-1d449082fc34"
    }
  ],
  "offerDetails": {
    "offerType": "promotion",
    "name": {},
    "discountPercentage": 0,
    "presetMenuType": "generic",
    "price": 0,
    "currency": "string"
  },
  "utmTrackingInformation": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "billAmount": {
    "totalPrice": 0,
    "currency": "string"
  },
  "reservationChannel": "TripAdvisor",
  "createdAt": "string",
  "updatedAt": "string"
}

401

Unauthorized

*/*

Schema

Schema

data object
error string

Possible values: [Unauthorized]

statusCode number

Possible values: [401]

Example (from schema)

{
  "data": {},
  "error": "Unauthorized",
  "statusCode": 401
}

404

Not Found

*/*

Schema

Schema

data

object

code string

Possible values: [RESERVATION_NOT_FOUND]

error string

Possible values: [Not Found]

statusCode number

Possible values: [404]

Example (from schema)

{
  "data": {
    "code": "RESERVATION_NOT_FOUND"
  },
  "error": "Not Found",
  "statusCode": 404
}

Loading...